Contents x
    Bulk unpublish articles, reverting them to draft.
    • 12 May 2026
    • 7 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Contents

    Bulk unpublish articles, reverting them to draft.

    • Updated on 12 May 2026
    • 7 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Article summary

    Post
    /v3/projects/{project_id}/articles/bulk/unpublish

    Unpublishes up to 100 articles in a single request, reverting each to draft status. Each article is processed independently — if one fails, others are still unpublished. The response includes per-article success/failure results. Requires PublishArticles permission. Unpublished articles retain their content but are no longer visible on the knowledge base site.

    Security
    OAuth

    All V3 endpoints require a Bearer token. Generate tokens in the Document360 portal under Settings > API Tokens. Tokens are project-scoped, require the customerApi scope, and do not expire by default. Tokens can be revoked at any time from the portal. Include the token in every request: Authorization: Bearer <your-token>. Alternatively, use the Authorize button below to sign in via OAuth2 Authorization Code flow with PKCE.

    FlowAuthorization Code
    Authorization URLhttps://identity.document360.net/connect/authorize
    Token URLhttps://identity.document360.net/connect/token
    Scopes:
    customerApiDocument360 Customer API
    Path parameters
    project_id
    string (uuid) Required

    The unique identifier of the project. Retrieve project IDs from GET /v3/projects.

    Example9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d
    Query parameters
    lang_code
    string

    ISO 639-1 language code (e.g., en, fr). Defaults to the project's primary language if omitted.

    Pattern^[a-z]{2}(-[A-Z]{2})?$
    Exampleen
    Body parameters

    The list of article IDs to unpublish. Maximum 100 articles per request.

    Bulk operation by IDs

    Provide a list of article IDs to publish or unpublish. Maximum 100 IDs per request.

    {
  "ids": [
    "9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d",
    "c5d6e7f8-9a0b-1c2d-3e4f-5a6b7c8d9e0f"
  ]
}
    object

    Request containing a list of entity IDs for bulk publish or unpublish operations.

    ids
    Array of string Required

    The list of entity identifiers. Maximum 100 items per request.

    Max items100
    string
    Responses
    200

    Articles unpublished successfully.

    Bulk operation completed

    Results for each item in the bulk request. Check individual success flags to identify failures.

    {
  "data": [
    {
      "index": 0,
      "id": "9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d",
      "success": true,
      "details": "Article created successfully."
    },
    {
      "index": 1,
      "id": "c5d6e7f8-9a0b-1c2d-3e4f-5a6b7c8d9e0f",
      "success": true,
      "details": "Article created successfully."
    }
  ],
  "success": true,
  "request_id": "req_abc123def456",
  "errors": null,
  "warnings": null
}
    Bulk operation with partial failure

    Some items in the bulk request may fail while others succeed. The top-level success is false when any item fails. Use the index field to correlate results with input items.

    {
  "data": [
    {
      "index": 0,
      "id": "9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d",
      "success": true,
      "details": "Article created successfully."
    },
    {
      "index": 1,
      "id": null,
      "success": false,
      "details": "The Title field is required."
    }
  ],
  "success": false,
  "request_id": "req_abc123def456",
  "errors": null,
  "warnings": null
}
    Expand All
    object

    Generic API response wrapper containing typed data.

    data
    Array of object (BulkOperationResult)

    Response data payload.

    object

    Result of a bulk operation on a single item.

    index
    integer (int32)

    The zero-based position of this item in the original request array, enabling correlation of results to input items even when the operation fails and no ID is available.

    Example0
    id
    string (uuid) | null

    The identifier of the item that was processed. May be null for failed create operations where no resource was created.

    Example9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d
    success
    boolean

    Whether the operation succeeded for this item.

    Exampletrue
    details
    string | null

    Additional details or error message for the operation.

    ExampleArticle created successfully.
    success
    boolean

    Whether the API request was successful.

    request_id
    string

    Unique identifier for request tracing and correlation.

    Min length1
    errors
    Array of object (ApiError) | null

    List of errors if the request failed.

    object

    Represents an error returned by the API.

    code
    string

    Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

    Min length1
    message
    string

    Human-readable error message.

    Min length1
    field
    string | null

    The request field that caused the error, if applicable.

    details
    string | null

    Additional context about the error.

    warnings
    Array of object (ApiWarning) | null

    List of non-fatal warnings from the request.

    object

    Represents a non-fatal warning from the API.

    code
    string

    Machine-readable warning code.

    Min length1
    message
    string

    Human-readable warning message.

    Min length1
    400

    The request body is malformed or contains invalid JSON.

    Expand All
    object

    RFC 7807 Problem Details response for V3 API errors. Content-Type: application/problem+json

    type
    string

    URI reference identifying the error type (links to documentation).

    Min length1
    title
    string

    Short human-readable summary of the error type.

    Min length1
    status
    integer (int32)

    HTTP status code.

    detail
    string | null

    Human-readable explanation specific to this occurrence.

    instance
    string | null

    URI of the request that generated the error.

    trace_id
    string | null

    Request trace identifier for correlation.

    errors
    Array of object (ApiError) | null

    Structured list of specific errors (extension field).

    object

    Represents an error returned by the API.

    code
    string

    Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

    Min length1
    message
    string

    Human-readable error message.

    Min length1
    field
    string | null

    The request field that caused the error, if applicable.

    details
    string | null

    Additional context about the error.

    warnings
    Array of object (ApiWarning) | null

    Non-fatal warnings (extension field).

    object

    Represents a non-fatal warning from the API.

    code
    string

    Machine-readable warning code.

    Min length1
    message
    string

    Human-readable warning message.

    Min length1
    401

    Authentication token is missing or invalid.

    Headers
    WWW-Authenticate
    string
    Indicates the authentication scheme required. Returns `Bearer` with optional `error` and `error_description` parameters per RFC 6750.
    Missing or invalid token

    Authentication token is missing or invalid.

    {
  "type": "https://developer.document360.com/errors/unauthorized",
  "title": "Unauthorized.",
  "status": 401,
  "detail": "The authentication token is missing or has expired.",
  "instance": null,
  "trace_id": "req_abc123def456",
  "errors": [
    {
      "code": "UNAUTHORIZED",
      "message": "Bearer token is missing or invalid.",
      "field": null,
      "details": null
    }
  ],
  "warnings": null
}
    Expand All
    object

    RFC 7807 Problem Details response for V3 API errors. Content-Type: application/problem+json

    type
    string

    URI reference identifying the error type (links to documentation).

    Min length1
    title
    string

    Short human-readable summary of the error type.

    Min length1
    status
    integer (int32)

    HTTP status code.

    detail
    string | null

    Human-readable explanation specific to this occurrence.

    instance
    string | null

    URI of the request that generated the error.

    trace_id
    string | null

    Request trace identifier for correlation.

    errors
    Array of object (ApiError) | null

    Structured list of specific errors (extension field).

    object

    Represents an error returned by the API.

    code
    string

    Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

    Min length1
    message
    string

    Human-readable error message.

    Min length1
    field
    string | null

    The request field that caused the error, if applicable.

    details
    string | null

    Additional context about the error.

    warnings
    Array of object (ApiWarning) | null

    Non-fatal warnings (extension field).

    object

    Represents a non-fatal warning from the API.

    code
    string

    Machine-readable warning code.

    Min length1
    message
    string

    Human-readable warning message.

    Min length1
    429

    Rate limit exceeded. Retry after the duration specified in the Retry-After header.

    Headers
    Retry-After
    integer
    Number of seconds to wait before retrying the request. Use exponential backoff with jitter for optimal retry behavior.
    X-RateLimit-Limit
    integer
    The maximum number of requests allowed in the current time window. Limits are applied per API token per project.
    X-RateLimit-Remaining
    integer
    The number of requests remaining in the current time window. When this reaches 0, subsequent requests will receive a 429 response.
    X-RateLimit-Reset
    integer
    The UTC epoch timestamp (in seconds) when the current rate limit window resets.
    Rate limit exceeded

    Rate limit exceeded.

    {
  "type": "https://developer.document360.com/errors/too-many-requests",
  "title": "Too Many Requests.",
  "status": 429,
  "detail": "Rate limit exceeded. Retry after the duration specified in the Retry-After header.",
  "instance": null,
  "trace_id": "req_abc123def456",
  "errors": [
    {
      "code": "TOO_MANY_REQUESTS",
      "message": "Rate limit exceeded. Retry after the duration specified in the Retry-After header.",
      "field": null,
      "details": null
    }
  ],
  "warnings": null
}
    Expand All
    object

    RFC 7807 Problem Details response for V3 API errors. Content-Type: application/problem+json

    type
    string

    URI reference identifying the error type (links to documentation).

    Min length1
    title
    string

    Short human-readable summary of the error type.

    Min length1
    status
    integer (int32)

    HTTP status code.

    detail
    string | null

    Human-readable explanation specific to this occurrence.

    instance
    string | null

    URI of the request that generated the error.

    trace_id
    string | null

    Request trace identifier for correlation.

    errors
    Array of object (ApiError) | null

    Structured list of specific errors (extension field).

    object

    Represents an error returned by the API.

    code
    string

    Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

    Min length1
    message
    string

    Human-readable error message.

    Min length1
    field
    string | null

    The request field that caused the error, if applicable.

    details
    string | null

    Additional context about the error.

    warnings
    Array of object (ApiWarning) | null

    Non-fatal warnings (extension field).

    object

    Represents a non-fatal warning from the API.

    code
    string

    Machine-readable warning code.

    Min length1
    message
    string

    Human-readable warning message.

    Min length1
    500

    An unexpected server error occurred.

    Unexpected server error

    Unexpected server error.

    {
  "type": "https://developer.document360.com/errors/internal-error",
  "title": "Internal Server Error.",
  "status": 500,
  "detail": "An unexpected error occurred. Please try again or contact support.",
  "instance": null,
  "trace_id": "req_abc123def456",
  "errors": [
    {
      "code": "INTERNAL_SERVER_ERROR",
      "message": "An unexpected error occurred.",
      "field": null,
      "details": null
    }
  ],
  "warnings": null
}
    Expand All
    object

    RFC 7807 Problem Details response for V3 API errors. Content-Type: application/problem+json

    type
    string

    URI reference identifying the error type (links to documentation).

    Min length1
    title
    string

    Short human-readable summary of the error type.

    Min length1
    status
    integer (int32)

    HTTP status code.

    detail
    string | null

    Human-readable explanation specific to this occurrence.

    instance
    string | null

    URI of the request that generated the error.

    trace_id
    string | null

    Request trace identifier for correlation.

    errors
    Array of object (ApiError) | null

    Structured list of specific errors (extension field).

    object

    Represents an error returned by the API.

    code
    string

    Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

    Min length1
    message
    string

    Human-readable error message.

    Min length1
    field
    string | null

    The request field that caused the error, if applicable.

    details
    string | null

    Additional context about the error.

    warnings
    Array of object (ApiWarning) | null

    Non-fatal warnings (extension field).

    object

    Represents a non-fatal warning from the API.

    code
    string

    Machine-readable warning code.

    Min length1
    message
    string

    Human-readable warning message.

    Min length1
    Was this article helpful?
    What's Next
    Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy.
    Products
    Company
    Top Features
    Solutions
    Existing Users
    Connect With Us
    Sales and Support
    Copyright © Abc Inc. All Rights Reserved